Skip to main content

How to Test and Validate onboarding JSON files

Testing with local JSON file​

  1. Go to the JSON previewer link.
  2. Choose Upload JSON to upload the file you'd like to validate and test. (if you have the JSON data copied into the clipboard, you can choose Upload from clipboard instead)
  3. If your file is valid, you’ll be able to see the onboarding steps instantly, otherwise, you will see the errors that caused the validation to fail.

Errors example where welcome_inter is the stepId of the invalid step.

In case of any errors, please fix them and re-upload the file to test the onboarding.

Screenshot of a valid onboarding:

Screenshot 2024-02-16 at 1.24.05 PM.png

[!IMPORTANT] To learn more about the structure of the JSON files, check it out here in [Onboarding Templates](Onboarding Templates).

Testing directly from Airtable​

You can effortlessly test new onboardings directly from Airtable - and no deploying required! With two new buttons, you can instantly preview your onboarding JSON on either staging or production. This means faster, smoother testing and an even more streamlined process.

What is more the airtable already have in development onboardings (status in development). These are not deployed and this feature should help with editing these jsons from airtable directly. So no need to deploy but you can work on json there and preview immediately.